lib/repo-pull: Document all options in pull_from_remotes_async
authorMatthew Leeds <matthew.leeds@endlessm.com>
Wed, 28 Mar 2018 20:33:08 +0000 (13:33 -0700)
committerAtomic Bot <atomic-devel@projectatomic.io>
Thu, 29 Mar 2018 00:18:21 +0000 (00:18 +0000)
ostree_repo_pull_from_remotes_async() passes along some options to
ostree_repo_pull_with_options(), so document them.

Closes: #1519
Approved by: cgwalters

src/libostree/ostree-repo-pull.c

index 89c67c8e20283463be8a78f7fa5d89e53f9468e6..6170b011d78f20679035460c9f7683b8117e0e4a 100644 (file)
@@ -5396,6 +5396,13 @@ copy_option (GVariantDict       *master_options,
  *   * `flags` (`i`): #OstreeRepoPullFlags to apply to the pull operation
  *   * `inherit-transaction` (`b`): %TRUE to inherit an ongoing transaction on
  *     the #OstreeRepo, rather than encapsulating the pull in a new one
+ *   * `depth` (`i`): How far in the history to traverse; default is 0, -1 means infinite
+ *   * `disable-static-deltas` (`b`): Do not use static deltas
+ *   * `http-headers` (`a(ss)`): Additional headers to add to all HTTP requests
+ *   * `subdirs` (`as`): Pull just these subdirectories
+ *   * `update-frequency` (`u`): Frequency to call the async progress callback in
+ *     milliseconds, if any; only values higher than 0 are valid
+ *   * `append-user-agent` (`s`): Additional string to append to the user agent
  *
  * Since: 2017.8
  */